home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 2 / MacMania 2.toast / Demo's / Tools&Utilities / Netwerk⁄Telecom / Chat 2.01 / Chat Documentation < prev    next >
Encoding:
Text File  |  1992-03-16  |  12.9 KB  |  240 lines  |  [TEXT/ttxt]

  1. **** WHATS NEW ****
  2.  
  3. This is a new and improved version of Peter N. Lewis's Chat 1.1 
  4. Macintosh TCP/IP Chat Server. It now supports changing of channels,
  5. changing of user names, and many other nifty features. To customize
  6. it you will need to use ResEdit - most of the program's strings are contained
  7. in resources so it can be customized rather extensively.
  8.  
  9. New Commands:
  10.  User Help                               /HELP
  11.  Changing channel                        /CHANNEL ch-name
  12.  Whispering to another user              /WHISPER user
  13.  Yelling to all channels                 /YELL msg
  14.  Change your name                        /SET NAME newname
  15.  Page a user to your channel             /PAGE user
  16.  List users on all channels              /LISTALL
  17.  List users on current channel only      /LIST
  18.  Rolling dice (for games I suppose)      /DICE count
  19.  
  20.  Hiding from other users (Admin Only)    \HIDE admin-pswd
  21.  Unhideing from other users (Admin Only) \UNHIDE admin-pswd
  22.  Disconnect A User (Admin Only)          \KILL admin-pswd user
  23.  Disconnect All (Admin Only)             \RESTART admin-pswd
  24.  Administrator Help                      \HELP
  25.  User and Administrator Passwords
  26.  
  27.  
  28. The default TCP port to connect to: 1420
  29. The default user password for Chat 2.0 is "permission".
  30. The default admin password for Chat 2.0 is "admin".
  31.  
  32. The source code to chat 2.0 is available by request from nneul@umr.edu
  33.  
  34. If anyone would like to write some better documentation for Chat 2.0 -
  35. please do so and send it to me - I just do not have the time to do it.
  36.  
  37. Thanks...
  38.  
  39. Email any comments/suggestions/complaints/etc. to:  nneul@umr.edu
  40.  
  41. This software is shareware - if you want to distribute it on any commercial
  42. medium (information services, CD, etc.) contact me first - I would appreciate
  43. a sample copy of the CD for example.
  44.  
  45. A sample telnet session to the chat server is enclosed.
  46.  
  47. -- Nathan Neulinger
  48.  
  49. BTW, I am a poor college student - send money... :)
  50.  
  51. *************************************************************************
  52. The following is the documentation enclosed w/ Chat 1.1.0. 
  53. *************************************************************************
  54.  
  55. Chat 1.1.0 © Peter N Lewis, Mar 1992.
  56. This program is free, but I retain the copyright on it.
  57.  
  58. This program was initially written to assist in the online meetings of the TopSoft group, a group of mac programmers on the Internet, dedicated to producing free, high quality software and sample code.  To get more information about this group, ftp to syrinx.kgs.ukans.edu and check out the /topsoft directory, or send some mail to ts-request@syrinx.kgs.ukans.edu and ask to be added to the mailing list.
  59.  
  60. • Contents
  61.  
  62.       What Chat Does
  63.       Using Chat
  64.       Customising Chat
  65.       How It Works
  66.       Limitations
  67.       Small Print
  68.       Warranty
  69.       Fine Print
  70.       Version History
  71.       The Author
  72.  
  73. • What Chat Does
  74.  
  75. Chat is a background only application that lets Macs with MacTCP 1.1 serve as a very primitive IRC.  Once Chat is running on your mac, multiple people can Telnet to port 1420 on your mac and have online discussions .  Chat has no macintosh user interface, the only way to use it is by telneting to your mac.  I wrote this to hold the weekly online meetings of the TopSoft group, which have proved very successful.   Chat can support upwards of 12 users with the current memory partition (200k), and can support an arbitrarily large number of users given enough memory (though MacTCP will probably blow up if you try too many :-).  Add about 5 or 10k for each extra users you want.
  76.  
  77. • Using Chat
  78.  
  79. You must have MacTCP 1.1 installed in order to use Chat.
  80.  
  81. Put Chat or an alias to it in the Startup Folder (System 7) or make it a startup application (System 6 - note you will have to use "Selected Applications and DAs" since background only applications are not counted as Open Applications under System 6).  Double-Click Chat to get it started now.
  82.  
  83. Now you need to connect to Chat using NCSA/Telnet, MUDDweller, telnet on unix or VMS machines or some other method...
  84.  
  85. NCSA/Telnet:
  86. Choose Open Connection from the File Menu, type in the name (or IP number) of your mac, a space and then the port number (1420).
  87.  
  88. MUDDweller:
  89. Choose New, then choose TCP/IP Address from the configure menu and type in the ip numbers of your mac (or the name for newer versions of MUDDweller), and the port number (1420).  Hit OK, and then choose Open Connection from the Configure menu.
  90.  
  91. Unix:
  92. telnet <macname or ip number> 1420
  93.  
  94. VMS:
  95. telnet <macname or ip number> /port=1420
  96.  
  97. When you connect, it will ask you for a channel.  Channels are defined in a STR# resource inside chat (no, I'm not going to make a fancy UI for editing it).  By default, there are two channels, “normal” and “nolog”.  The normal channel is logged to Normal Log on your system volume.  The nolog channel is not logged (obviously :-).  After that it will ask you for your name.  You are now logged in, but Chat is very boring with only one person logged in, so get someone else to log in as well, or log in yourself several times.  From now on anything you type will be echoed to all other users in a format like this:
  98.  
  99. I type “Hello”, and others would see:
  100. PeterL: Hello
  101.  
  102. Here is a sample session:
  103.  
  104. **** Sample Session ****
  105. unixprompt> telnet mymac 1420
  106. Welcome to Peter's Private Party Line.
  107. Select a channel ("normal" is a good bet):normal
  108. Enter your name:PeterL
  109. Welcome.  Commands start with a  slash (/), everything else goes to the channel.
  110. Warning: Everything said is logged and may be used against you.
  111. /LIST
  112. FredB
  113. Hi Fred, whats up?
  114. FredB: Ahh, Peter you showed up.  Nothing much, usual stuff.
  115. FredB: How's Chat coming along?
  116. FredB: How is Chat coming along?
  117. ****
  118.  
  119. Here, I typed the lines:
  120. telnet mymac 1420
  121. normal (third line)
  122. PeterL (fourth line)
  123. Hi Fred, whats up?
  124.  
  125. Try it out, you’ll get the idea pretty quick.
  126.  
  127. There are several commands, they all start with a slash (/), to get a list, just type "/<return>":
  128.  
  129. ****
  130. /
  131. Bad command.  Commands are:
  132. /QUIT - exit chat, but why would you want to leave?
  133. /LIST - display a list of people on this channel.
  134. /DO <action> - display an action like "Yourname <action>"
  135. /ME <action> - same as /DO
  136. /SET <variable> <value> - set a variable (eg /SET echo true)
  137. everything else is sent to everyone on the channel.
  138. ****
  139.  
  140. There is also a silent command which only the owner should use, QUITNOW (case IS relevant), which closes the server down.  Don’t use this on someone else’s server!  As the owner, you can change this command by changing the Globals STR#, but you probably wont need to, since no one reads the documentation anyway, they'll never find out about it :-)
  141.  
  142. There is no way to change channels once you are on, or to listen in on more than one channel at once (except by connecting to the server more than once of course).
  143.  
  144. • Customising Chat
  145.  
  146. You can customise Chat by using ResEdit to change the STR# resource which contains the port number, the channel names, and log names, the Chat Log creator, the commands, and all the strings that Chat produces.
  147.  
  148. • How It Works
  149.  
  150. Chat is a very simple program, I wrote it in about three hours, plus I've done about a dozen more hours neatifying it, and a couple hours getting it ready to send out.  The entire program (ignoring the TCP and other libraries) is only a couple hundred lines, and as such should be a good starting sample code for writing TCP applications (the pascal source code will be sent out as with most of my programs).
  151.  
  152. All it does is listen to the TCP port specified in the STR# resource.  When it gets a new connection it starts up another listener, and deals with the user, first getting their channel and name, and then echoing all their messages to the other users on that channel.  It does this by keeping a list of all currently logged on users, when a line comes in from one user, it goes thru the list and echoes it (with the user’s name prepended) to all other users with the same channel.
  153.  
  154. • Limitations
  155.  
  156. Chat probably require the 128k ROM and System version 6.0 or higher.  It may well only work with a Mac IIsi (not mine)-:, and System 7.0.  It definitely requires MacTCP v1.1 or better yet 1.1.1.
  157.  
  158. There are several caveats.  Second, in a “crowded room”, you may have troubles with people all speaking at once (which is not a real problem for users using MUDDweller, but mucks up the screens of users who connect with other clients).  The solution we adopted was to start and end you messages with a blank line, so people can tell when you have finished, and avoid interrupting you once you have started.
  159.  
  160. • Small Print
  161.  
  162. This program is free, don’t bother sending me any money for this one, it was only a days work anyway.  If you like it, send me an Email message saying hello, or a postcard or something like that.
  163.  
  164. You may distribute Chat any way you wish as long as you don't charge for it (reasonable download costs such as Compu$erve are ok I guess (although who would call Compu$erve's download costs reasonable?)).  It would probably be a good idea to keep this documentation file with the program, but I'm hardly likely to check up on you now am I!  I don't guarantee any support, but I always answer my Email (I'm not so good with snail-mail and those horrible little bits of paper and such!).  If I don't answer Email its because your message didn't get to me, or my reply bounced (so try again, and include a valid Internet address if you can).
  165.  
  166. You MAY NOT distribute it on any magnetic media you charge for without my express permission unless you charge less that US$3 for the disks (and no membership costs).  I am sick and tired of seeing people selling PD/Shareware software for ten dollars a disk without any reimbursement to the authors.  If you are a legitimate user group, let me know and I'll waive teh "no membership costs" restriction. 
  167.  
  168. • Warranty
  169.  
  170.       There is absolutely NO warranty, guarantee, hint, suggestion or anything else that would lead anyone to think that Chat do anything stated in this documentation.  It usually does not destroy data (systems, hardware, etc), and has sometimes worked on my Mac with System 7.0.  It is highly unlikely that it will work with older systems (pre 6.0 anyway) or with the 64k ROM.  It might work with the other models, but I don't have them all, so I don't know (Anyone want to give me a IIfx (or one of those new beasts?  How did they come up with such a terrible name???) so I can check for compatibility?).  It might work with future versions of MacTCP (after 1.1.1), but who can tell?  If it works on your system (or especially if it doesn't!), send me a postcard or some Email and let me know!
  171.  
  172. • Fine Print
  173.  
  174.       Peter Lewis hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose.  Does any one really read this stuff.  Peter Lewis will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Peter Lewis or an agent of his has been advised of the possibility of such damages.  In no event shall Peter Lewis be liable for any damages, regardless of the form of the claim.  The person using the software bears all risk as to the quality and performance of the software.
  175.  
  176. • Version History
  177.  
  178. Still to do -
  179.  
  180. Perhaps a password facility.
  181. Private message facility - nope, I've decided not to do this.
  182. Uniteruptable messages
  183. Log play back
  184.  
  185. v1.1.0
  186. ~Multiple channels
  187. ~New / command structure
  188.  
  189. v1.0.1
  190. ~Word wrapping lines.
  191.  
  192. v1.0.0
  193. ~Moved strings into resource fork.
  194. ~Improved strings
  195.  
  196. *****
  197. * The Author
  198.  
  199. Programs written by me:
  200. Anarchie 1.1.0 - Macintosh Archie client and FTP browser.
  201. Morpion 1.0.0 - A simple solitaire game.
  202. FTPd 2.2.0 - Macintosh FTP server.
  203. Daemon 1.0.0 - Macintosh multi-protocol daemon.
  204. Script Daemon 1.0.0 - Telnet->AppleScript gateway
  205. DeHQX 2.0.1 - BinHex decoder (use StuffIt Expander instead).
  206. Finger 1.3.7 - Macintosh Finger client/daemon.
  207. Talk 1.1.1 - Macintosh Talk client/daemon.
  208. MacTCP Watcher 1.1.0 - Display MacTCP state information.
  209. MacBinary II+ 1.0.2 - MacBinary II+ encoder/decoder.
  210. ObiWan 4.0.1 - Online help system.
  211. Bolo Finder 1.0.2 - Display the results from Mike Ellis' Bolo Tracker.
  212. Bolo RandomMap 1.1.0 - Generate a random map for Bolo.
  213. FetchNews 1.0.0b - Fetch News for use with NewsWatcher demo mode.
  214. Chat 1.1.0 - Multiuser primitive irc-like daemon.
  215.  
  216. The latest versions of my programs are available from:
  217. amug.org:/pub/ftp1/peterlewis
  218. redback.cs.uwa.edu.au:/others/peterlewis
  219. and French versions of some of my programs may be available from:
  220. ftp.sri.ucl.ac.be:/pub.
  221.  
  222. You can sometimes get the latest development versions from redback, but
  223. only use the development versions if you have some specific problem - in
  224. which case you should tell me, especially since the development versions on
  225. redback are often not the latest versions I have)
  226.  
  227. Send postcards, comments, bug reports, wishes, and payments to:
  228.  
  229. Peter Lewis,
  230. 10 Earlston Way,
  231. Booragoon, Perth, WA, 6154,
  232. AUSTRALIA
  233.  
  234. or by electronic mail to:
  235.  
  236. Internet: peter.lewis@info.curtin.edu.au
  237. Bitnet: peter.lewis%info.curtin.edu.au@cunyvm.bitnet
  238. UUCP: uunet!munnari.oz!info.curtin.edu.au!peter.lewis
  239. *****
  240.